Interface HTTPServer

All Superinterfaces:
IPCObject, Process
All Known Subinterfaces:
HTTPsServer
All Known Implementing Classes:
HTTPServerImpl, HTTPsServerImpl

public interface HTTPServer extends Process
Information provided by the PKI file:

    \class HttpServer
    
    \brief HttpServer handles and manipulates the HTTP server on devices.
    
    \example network().getDevice("Server0").getProcess("HttpServer")
    
Author:
Auto-generated
  • Method Details

    • setPortNumber

      void setPortNumber(Short port)
      Information provided by the PKI file:
      
          \brief Sets the port number of the HTTP service.
          
          \param num, the port number to set the HTTP service to.
          
              
      Parameters:
      port - Takes in a parameter of port
    • getPortNumber

      Short getPortNumber()
      Information provided by the PKI file:
      
          \brief Returns the port number of the HTTP service.
          
          \return int, the port number of the HTTP service.
          
              
      Returns:
      Short Returns a Short
    • setEnable

      void setEnable(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables the HTTP service.
          
          \param bEnable, true to enable the HTTP service, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • isEnabled

      boolean isEnabled()
      Information provided by the PKI file:
      
          \brief Returns true if the HTTP service is enabled, otherwise false.
          
          \return bool, true if the HTTP service is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getPage

      String getPage(String url)
      Information provided by the PKI file:
      
          \brief Returns the page contents at the specified URL.
          
          \param url, the URL of the page of interest.
          
          \return string, the page contents at the specified URL.
          
              
      Parameters:
      url - Takes in a parameter of url
      Returns:
      String Returns a String
    • setPageContents

      void setPageContents(String url, String contents)
      Information provided by the PKI file:
      
          \brief Sets the page contents at the specified URL.
          
          \param url, the URL of the page of interest.
          \param contents, the contents of the page of interest.
          
              
      Parameters:
      url - Takes in a parameter of url
      contents - Takes in a parameter of contents
    • getUsername

      String getUsername()
      Information provided by the PKI file:
      
          \brief Returns the htaccess username for the HTTP server.
          
          \return string, the htaccess username for the HTTP server.
          
              
      Returns:
      String Returns a String
    • getPassword

      String getPassword()
      Information provided by the PKI file:
      
          \brief Returns the htaccess password for the HTTP server.
          
          \return string, the htaccess password for the HTTP server.
          
              
      Returns:
      String Returns a String
    • setUsername

      void setUsername(String username)
      Information provided by the PKI file:
      
          \brief Sets the htaccess username for the HTTP server.
          
          \param username, the htaccess username for the HTTP server.
          
              
      Parameters:
      username - Takes in a parameter of username
    • setPassword

      void setPassword(String password)
      Information provided by the PKI file:
      
          \brief Sets the htaccess password for the HTTP server.
          
          \param password, the htaccess password for the HTTP server.
          
              
      Parameters:
      password - Takes in a parameter of password